-
Notifications
You must be signed in to change notification settings - Fork 18
feat: Added in-memory storage for testing purposes #59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
👋 Thanks for assigning @tnull as a reviewer! |
tnull
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for looking into this!
Generally goes into the right direction, but we def. need to avoid re-allocating everything on every operation.
4980a75 to
25d57e3
Compare
|
@tnull Have done the required changes |
tnull
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks much better, but I think we still need to handle global_version properly, even if we're currently not using it client-side.
|
🔔 1st Reminder Hey @tankyleo! This PR has been waiting for your review. |
25d57e3 to
9012e95
Compare
tnull
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One comment, will take another look once @tankyleo also had a chance to do a review round here.
9012e95 to
3b434d0
Compare
|
@tankyleo Can you please review it! |
|
🔔 3rd Reminder Hey @tankyleo! This PR has been waiting for your review. |
|
🔔 4th Reminder Hey @tankyleo! This PR has been waiting for your review. |
|
🔔 5th Reminder Hey @tankyleo! This PR has been waiting for your review. |
tankyleo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the delay !
| version: record.version, | ||
| }), | ||
| }) | ||
| } else if request.key == GLOBAL_VERSION_KEY { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like by the time we are here, we know the GLOBAL_VERSION_KEY does not have a value, otherwise guard.get would have returned Some previously. We can just return the GetObjectResponse below directly with version: 0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Harshdev098 double checking things here, we still have this second branch the same as before ?
rust/impls/src/in_memory_store.rs
Outdated
| let key_prefix = request.key_prefix.unwrap_or_default(); | ||
| let page_token = request.page_token.unwrap_or_default(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you don't mind, let's use the more explicit unwrap_or here like we have just below. unwrap_or_default is a little hard to read.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Harshdev098 help me understand we still have the unwrap_or_default here ? If you would prefer unwrap_or_default let me know.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh, actually I was debugging the issue of CI and have forgot to use unwrap_or, will update it!
3b434d0 to
e0c31bb
Compare
|
@tankyleo Have done with the required changes! Can you please review it |
8003119 to
5898609
Compare
tnull
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When testing integration with LDK Node locally I found that the tests are currently failing. I now opened #62 to add LDK Node integration tests to our CI here. It would be great if that could land first, and we could also add a CI job for the in-memory store as part of this PR then, ensuring the implementation actually works as expected.
|
🔔 1st Reminder Hey @tankyleo! This PR has been waiting for your review. |
|
🔔 2nd Reminder Hey @tankyleo! This PR has been waiting for your review. |
|
@Harshdev098 Please rebase now that #62 landed to make use of the new CI checks here. |
tnull
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please also make sure that the LDK Node CI is run against the in-memory store.
AFAICT this is still missing the part that runs the LDK Node integration test against the in-memory store to check functionality in a realistic setting?
81ca808 to
1f18bd8
Compare
|
🔔 5th Reminder Hey @tankyleo! This PR has been waiting for your review. |
84cfed6 to
939559f
Compare
tnull
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, and now you're hitting the errors that I originally found when running LDK Node against the in-memory store. Very likely, they are due to the in-memory implementation behaving in an unexpected manner. We need to fix this before this PR can get merged. Please take a look, but let me know if you end up getting stuck or need some assistance figuring this out.
|
🔔 6th Reminder Hey @tankyleo! This PR has been waiting for your review. |
51a791d to
0168750
Compare
|
Hey @tnull Have updated the code and the unit test are passing against the ldk node tests but didn't understand what is the cause of integration failures |
92bd1e3 to
bd3eca4
Compare
9ec0e79 to
45fecd1
Compare
tankyleo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the delay again I have cleared all the other priorities, this is now top priority :) Here are some comments, mostly on the types we pass to the different functions.
Will continue review tomorrow 100% ! Thank you again.
| ErrorKind::Other, | ||
| format!("Failed to drop database {}: {}", db_name, e), | ||
| ) | ||
| Error::new(ErrorKind::Other, format!("Failed to drop database {}: {}", db_name, e)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry the formats in this file were done in a CI-specific PR we merged, go ahead and rebase and drop them thank you :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Harshdev098 sorry i take it back, don't rebase to a new commit just yet :) if you can just drop these changes, keep the same base commit on main, will rebase to a newer base commit as necessary thank you
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ohh sorry @tankyleo , but I have done it already, my branch is now up to date with main
rust/impls/src/in_memory_store.rs
Outdated
| let mut vss_put_records: Vec<VssDbRecord> = request | ||
| .transaction_items | ||
| .into_iter() | ||
| .map(|kv| build_vss_record(user_token.clone(), store_id.clone(), kv)) | ||
| .collect(); | ||
|
|
||
| let vss_delete_records: Vec<VssDbRecord> = request | ||
| .delete_items | ||
| .into_iter() | ||
| .map(|kv| build_vss_record(user_token.clone(), store_id.clone(), kv)) | ||
| .collect(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's not build all these VssDbRecords when we still haven't validated the API input. Instead, let's pass the KeyValue's by reference to the validator functions (ie just read the input to validate it, no cloning / allocations).
Then once we've finished validation, we can build the VssDbRecord and insert into the db as needed.
My fn put function looks like this, feel free to grab it and make the changes you want. I create the VssDbRecord inside the execute_put_object function.
async fn put(
&self, user_token: String, request: PutObjectRequest,
) -> Result<PutObjectResponse, VssError> {
if request.transaction_items.len() + request.delete_items.len() > MAX_PUT_REQUEST_ITEM_COUNT
{
return Err(VssError::InvalidRequestError(format!(
"Number of write items per request should be less than equal to {}",
MAX_PUT_REQUEST_ITEM_COUNT
)));
}
let store_id = request.store_id.clone();
let mut guard = self.store.write().await;
if let Some(version) = request.global_version {
validate_put_operation(&guard, &user_token, &store_id, &KeyValue { key: GLOBAL_VERSION_KEY.to_string(), value: Bytes::new(), version, })?;
}
for key_value in &request.transaction_items {
validate_put_operation(&guard, &user_token, &store_id, key_value)?;
}
for key_value in &request.delete_items {
validate_delete_operation(&guard, &user_token, &store_id, key_value)?;
}
for key_value in request.transaction_items {
execute_put_object(&mut guard, &user_token, &store_id, key_value);
}
for key_value in &request.delete_items {
execute_delete_object(&mut guard, &user_token, &store_id, key_value);
}
if let Some(version) = request.global_version {
execute_put_object(&mut guard, &user_token, &store_id, KeyValue { key: GLOBAL_VERSION_KEY.to_string(), value: Bytes::new(), version, });
}
Ok(PutObjectResponse {})
}
rust/impls/src/in_memory_store.rs
Outdated
| let vss_delete_records: Vec<VssDbRecord> = request | ||
| .delete_items | ||
| .into_iter() | ||
| .map(|kv| build_vss_record(user_token.clone(), store_id.clone(), kv)) | ||
| .collect(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also do not need to build VssDbRecords for the delete_items, so let's delete those.
rust/impls/src/in_memory_store.rs
Outdated
| fn build_vss_record(user_token: String, store_id: String, kv: KeyValue) -> VssDbRecord { | ||
| let now = Utc::now(); | ||
| VssDbRecord { | ||
| user_token, | ||
| store_id, | ||
| key: kv.key, | ||
| value: kv.value.to_vec(), | ||
| version: kv.version, | ||
| created_at: now, | ||
| last_updated_at: now, | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once we only build the VssDbRecord when we are about to insert into the database, we can delete this function here.
rust/impls/src/in_memory_store.rs
Outdated
|
|
||
| // Validation functions - check for if operations can succeed without modifying data | ||
| fn validate_put_operation( | ||
| store: &HashMap<String, VssDbRecord>, user_token: &str, store_id: &str, record: &VssDbRecord, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I described earlier, let's pass a key_value: &KeyValue here not a record: &VssDbRecord
rust/impls/src/in_memory_store.rs
Outdated
|
|
||
| fn execute_non_conditional_upsert( | ||
| store: &mut HashMap<String, VssDbRecord>, user_token: &str, store_id: &str, | ||
| record: &VssDbRecord, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are inserting the KeyValue into the database here, so let's pass a key_value: KeyValue here instead of the record: &VssDbRecord
rust/impls/src/in_memory_store.rs
Outdated
|
|
||
| fn execute_conditional_insert( | ||
| store: &mut HashMap<String, VssDbRecord>, user_token: &str, store_id: &str, | ||
| record: &VssDbRecord, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same reasoning as above, let's pass a key_value: KeyValue here
rust/impls/src/in_memory_store.rs
Outdated
|
|
||
| fn execute_conditional_update( | ||
| store: &mut HashMap<String, VssDbRecord>, user_token: &str, store_id: &str, | ||
| record: &VssDbRecord, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, a key_value: KeyValue fits better since we are only modifying an existing VssDbRecord, not creating a new one.
rust/impls/src/in_memory_store.rs
Outdated
|
|
||
| fn execute_non_conditional_delete( | ||
| store: &mut HashMap<String, VssDbRecord>, user_token: &str, store_id: &str, | ||
| record: &VssDbRecord, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here and below, we only need to pass a key_value: &KeyValue, as we are only reading the key, we do not need a &VssDbRecord
rust/impls/src/in_memory_store.rs
Outdated
|
|
||
| fn execute_delete_object( | ||
| store: &mut HashMap<String, VssDbRecord>, user_token: &str, store_id: &str, | ||
| record: &VssDbRecord, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also here let's just pass a key_value: &KeyValue, we do not need a record: &VssDbRecord
| Ok(DeleteObjectResponse {}) | ||
| } | ||
|
|
||
| async fn list_key_versions( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a deadlock here earlier have resolved that! now its running locally
rust/impls/src/in_memory_store.rs
Outdated
| let key_prefix = request.key_prefix.unwrap_or_default(); | ||
| let page_token = request.page_token.unwrap_or_default(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh, actually I was debugging the issue of CI and have forgot to use unwrap_or, will update it!
| ErrorKind::Other, | ||
| format!("Failed to drop database {}: {}", db_name, e), | ||
| ) | ||
| Error::new(ErrorKind::Other, format!("Failed to drop database {}: {}", db_name, e)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ohh sorry @tankyleo , but I have done it already, my branch is now up to date with main
45fecd1 to
c2a140e
Compare
|
@tankyleo Have updated the code |
Have added in_memory store for testing purpose.
We can edit config file to use specific store either postgresql or memory